Repository navigation
fix(logger): count buffer max_bytes in UTF-8 bytes - #8833
leandrodamascena merged 2 commits into
Conversation
|
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
leandrodamascena
left a comment
There was a problem hiding this comment.
Thanks @bardrop, second one in. Measuring in bytes in the three places that count keeps the running size honest when items get evicted, good call doing it through one helper. Goes out in 3.42.0, no need to rebase, you'll be in the release notes.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #8833 +/- ##
========================================
Coverage 97.20% 97.20%
========================================
Files 327 327
Lines 16757 16759 +2
Branches 1522 1522
========================================
+ Hits 16288 16290 +2
Misses 328 328
Partials 141 141 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|



Issue number: closes #8830
Summary
Changes
LoggerBufferCacheandKeyBufferCachesized items withlen(str(item)), which counts characters. They now use one small helper,_item_size(), that returnslen(str(item).encode("utf-8")). It is used in all three places (the "bigger than the whole buffer" check,add, andremove_oldest), so the running size stays consistent when items are evicted.No docs change:
docs/core/logger.mdalready saysmax_bytesis the "maximum size of the log buffer in bytes".User experience
Before: with
max_bytes=1600,logger.debug("é" * 1000)was buffered with no warning, though the record is about 2.2 KB in UTF-8.After: the record is counted in bytes, so it is treated like any record bigger than the buffer:
PowertoolsUserWarning("Cannot add item to the buffer...")and the log is written right away. ASCII-only logs behave the same as before.Verification
I used an AI assistant (Claude) to help write this change. I ran the tests below myself.
New tests:
tests/unit/logger/required_dependencies/test_logger_buffer_cache.py:test_cache_size_counts_utf8_bytes,test_item_larger_than_cache_in_bytestests/functional/logger/required_dependencies/test_powertools_logger_buffer.py:test_log_record_exceeding_buffer_size_in_bytes(publicLoggerAPI only)On
develop(fix reverted, tests kept):With the fix:
Full
uv run pytest -q tests/unit tests/functionalon this branch: 4056 passed, 73 skipped, 3 failed. The same 3 fail ondevelopwithout my change, and they come from test order, not this PR: oncetests/functional/metrics/datadogis collected,ddtraceis imported and addsdd.*keys to log records, sotest_append_context_keys_handles_empty_dictandtest_log_dict_key_strip_nonessee extra keys (both pass whentests/functional/loggerruns alone). The third,test_datadog_write_to_log_with_env_variable, passes when run alone. On my machine some full runs also hung in the Redis idempotency tests ondeveloptoo, so I ran the logger tests separately as well.ruff format --checkandruff checkon the changed files: clean.mypy aws_lambda_powertools/logging/: "Success: no issues found in 17 source files".By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.